FAQ
General questions
If you do not know which category below to select, simply start with this section.
- I am new to ONLYOFFICE Docs API. Where should I start?
- How to find out the current version number of ONLYOFFICE Docs?
- I want to change some ONLYOFFICE Docs parameters from the default.json configuration file. How can I do that so that my changes were not lost after update?
Security questions
The questions concerning ONLYOFFICE Docs security issues are in this section.
- How to limit access to my ONLYOFFICE Docs?
- What's the difference between sending the token in header and in body?
Sharing questions
The questions concerning document sharing with various permissions are in this section.
- How to open a document with "track changes" mode enabled?
- How to open a document with "commenting" mode enabled?
- How can the 'fillForms' parameter be used?
- How to enable both the editing and commenting mode for a document?
- Do the permission parameters influence each other?
- How to open the document in a viewer without the option to edit it?
- How to disable/enable the possibility to download the file?
- How to prevent a document from being printed?
- How to view and change sharing settings for a certain document?
- How to restrict commenting?
Embedding questions
The questions concerning inserting the document into a website page (embedding) are in this section.
- How to embed a document to a web site?
- How to change the behavior of the buttons in the embedded mode?
Co-editing questions
The questions concerning co-editing the documents with other users are in this section.
- How to check how many connections I need?
- How to find the information about users who are currently editing the document?
- How to disconnect users who are currently editing the document before saving the document?
Customizing questions
The questions concerning customizing the appearance of ONLYOFFICE Docs are in this section.
- How to whitelabel ONLYOFFICE Docs?
- How to change the default language of the ONLYOFFICE Docs interface?
- How to enable or disable the chat and/or the comments panel in the editors?
- How to customize the editors interface, e.g. adjust the top toolbar view?
- How to view and change the document additional parameters, e.g. its owner or uploading date?
- How to optimize the appearance of editors for a desktop computer, or for a mobile device, or for embedding into a web page?
- How to connect plugins to ONLYOFFICE Docs so that they become visible for all editor users?
Integrating questions
The questions concerning integrating ONLYOFFICE Docs with your own website and some other popular services (ownCloud, Nextcloud, SharePoint, etc.) are in this section.
- Where can I find integration examples for ONLYOFFICE Docs?
- Which paths should I specify when integrating ONLYOFFICE Docs with my website?
- What settings should be used when connecting ONLYOFFICE to ownClowd/Nextcloud via a local and public network?
Editing questions
The questions concerning editing documents using ONLYOFFICE Docs are in this section.
- What is the 'Callback handler' and why do I need it?
- What is the 'document.key' parameter?
- How to define the mode that the file should be opened in (viewing or editing)?
Managing versions questions
The questions concerning working with versions of documents are in this section.
- Which methods can be used when working with the document history events?
- How to display a document with highlighted changes?
- Why is a new version not shown in the document history after I forcefully save a document?
Saving questions
The questions concerning saving the documents are in this section.
- How to forcefully save the document to my storage when editing it?
- How to save the created document?
- How to save the opened document to another document file type?
- How to enable or disable the 'Autosave' option?
- What is the conversion start delay time and how can it be changed?
- How to specify the encoding type when converting from the csv or txt formats?
Renaming questions
The questions concerning renaming the documents are in this section.
- How to rename the created document?
- How to update the name of the document for all collaborative editors?
Using WOPI
The questions concerning using WOPI are in this section.
- How to enable WOPI?
- How can I configure the ONLYOFFICE Docs to accept WOPI requests only from the trusted integrator?
- Why do I need the discovery XML and how can I get it?
- How to customize the editor behavior via WOPI?
- How to create an online office session within the application?
- How to restrict public access to the data via WOPI?
- Where can I find possible WOPI error codes and their descriptions?
- Which WOPI REST API operations are supported by ONLYOFFICE Docs?
- How to restrict access to the use of ONLYOFFICE server via WOPI?
- How to get information about the file properties, access rights and editor settings via WOPI?
- What actions are supported via WOPI?
- Which access rights can I set to the document via WOPI?
- What are the difference between ONLYOFFICE Docs API and WOPI?